/**
 * 
 * Copyright (C) 2011 Cody Stoutenburg . All rights reserved.
 *
 *       This program is free software; you can redistribute it and/or
 *       modify it under the terms of the GNU Lesser General Public License
 *       as published by the Free Software Foundation; either version 2.1
 *       of the License, or (at your option) any later version.
 *
 *       This program is distributed in the hope that it will be useful,
 *       but WITHOUT ANY WARRANTY; without even the implied warranty of
 *       MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *       GNU Lesser General Public License for more details.
 *
 *       You should have received a copy of the GNU Lesser General Public License
 *       along with this program; if not, write to the Free Software
 *       Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA. 
 * 
 */
package ca.usherbrooke.behaviours;

import jade.core.AID;
import jade.core.Agent;
import jade.lang.acl.ACLMessage;
import jade.lang.acl.MessageTemplate;

import java.util.ArrayList;
import java.util.List;

/**
 * @author Cody Stoutenburg
 * 
 */
public class BasicSubscriptionBehaviour<E extends Agent> extends
		BasicBehaviour<E> {
	private static final long serialVersionUID = 1L;

	public static final String MY_SUBSCRIBE = "proto.subscribe";

	private final List<AID> allSubscriber;

	private final MessageTemplate subscribe;
	private final MessageTemplate unsubscribe;

	public static ACLMessage createSubscriptionMessage() {
		ACLMessage msg = new ACLMessage(ACLMessage.INFORM);
		msg.setProtocol(MY_SUBSCRIBE);
		return msg;
	}

	public BasicSubscriptionBehaviour(E agent, MessageTemplate subscribe,
			MessageTemplate unsubscribe) {
		super(agent);
		allSubscriber = new ArrayList<AID>();
		this.subscribe = subscribe;
		this.unsubscribe = unsubscribe;
	}

	@Override
	public void action() {
		ACLMessage msg = this.getAgent().receive(
				MessageTemplate.or(subscribe, unsubscribe));
		if (msg != null) {
			if (subscribe.match(msg)) {
				allSubscriber.add(msg.getSender());
			} else if (unsubscribe.match(msg)) {
				allSubscriber.remove(msg.getSender());
			}
		} else {
			block();
		}
	}

	@Override
	public boolean done() {
		return false;
	}

	public void sendSubscription(ACLMessage msg) {
		for (AID user : allSubscriber) {
			msg.addReceiver(user);
		}
		msg.setPerformative(ACLMessage.INFORM);
		msg.setProtocol(MY_SUBSCRIBE);
		this.getAgent().send(msg);
	}
}
